issue_2501_addition_of_missing_safety_docs_templates#574
issue_2501_addition_of_missing_safety_docs_templates#574pahmann merged 43 commits intoeclipse-score:mainfrom
Conversation
|
The created documentation from the pull request is available at: docu-html |
26e74d8 to
7a74e1b
Compare
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst
Show resolved
Hide resolved
aschemmel-tech
left a comment
There was a problem hiding this comment.
See inline comments and:
- add release/release_note.rst (platform release note template from release/guidance)
- add manual/safety_manual.rst (from https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/docs/manual/safety_manual.html)
- add requirements/index.rst (create stakeholder requirements document template, similar to the one for feature requirements)
Should I deleted the template in guidance then? |
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst
Show resolved
Hide resolved
|
@attifunel , you have still merge conflicts, please resolve them first |
I'm having issues in displaying them... they refer to a deleted file |
aschemmel-tech
left a comment
There was a problem hiding this comment.
see inline comments
process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst
Show resolved
Hide resolved
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/modules/module_name/docs/release/release_note.rst
Outdated
Show resolved
Hide resolved
aschemmel-tech
left a comment
There was a problem hiding this comment.
Inline comments plus: stakeholder requirements document template still missing?
process/folder_templates/platform/docs/release/release_note.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/release/release_note.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
There's a host of templates already here https://eclipse-score.github.io/process_description/main/process_areas/requirements_engineering/guidance/requirements_templates.html |
|
As discussed: only add the stakeholder requirement templates and replace the definition in the process area section by links for Platform/Feature/Component requirements. |
aschemmel-tech
left a comment
There was a problem hiding this comment.
previous comments fixed now - new comments inline
process/folder_templates/modules/module_name/docs/security_mgt/index.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/modules/module_name/docs/security_mgt/index.rst
Show resolved
Hide resolved
Correct one duplicated entry as copy-paste issue for safety_analysis_fdr Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com>
…re/component requirements templates
f9fd6c5 to
236d4fe
Compare
Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
236d4fe to
e6bdf05
Compare
Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
masc2023
left a comment
There was a problem hiding this comment.
Beside the default attribute settings for security, fine for now
| :id: doc__platform_release_note | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: NO |
There was a problem hiding this comment.
In general, why did you remove Security: YES and let safety to ASIL_B? Please set both so user must actively set NO or QM, if needed. Not everything is safety: ASIL_B by default.
There was a problem hiding this comment.
In other templates it is always Safety ASIL B, security NO. In general this is just an example, I added a specific request below to set the required values
There was a problem hiding this comment.
Anyway I think I fixed
|
@attifunel , still doc building errors /home/runner/work/process_description/process_description/process/folder_templates/modules/module_name/docs/security_mgt/module_security_package_fdr.rst: WARNING: document isn't included in any toctree [toc.not_included] |
|
Should be fixed now.
|
Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
aschemmel-tech
left a comment
There was a problem hiding this comment.
I see my remarks covered
As per #2501, missing safety specific documentation templates were added